home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsISVGRendererPathGeometry.idl < prev    next >
Encoding:
Text File  |  2006-05-08  |  4.1 KB  |  116 lines
  1. /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is the Mozilla SVG project.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Crocodile Clips Ltd.
  19.  * Portions created by the Initial Developer are Copyright (C) 2002
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *   Alex Fritze <alex.fritze@crocodile-clips.com> (original author)
  24.  *
  25.  * Alternatively, the contents of this file may be used under the terms of
  26.  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27.  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28.  * in which case the provisions of the GPL or the LGPL are applicable instead
  29.  * of those above. If you wish to allow use of your version of this file only
  30.  * under the terms of either the GPL or the LGPL, and not to allow others to
  31.  * use your version of this file under the terms of the MPL, indicate your
  32.  * decision by deleting the provisions above and replace them with the notice
  33.  * and other provisions required by the GPL or the LGPL. If you do not delete
  34.  * the provisions above, a recipient may use your version of this file under
  35.  * the terms of any one of the MPL, the GPL or the LGPL.
  36.  *
  37.  * ***** END LICENSE BLOCK ***** */
  38.  
  39. #include "nsISupports.idl"
  40.  
  41. interface nsISVGRendererRegion;
  42. interface nsISVGRendererCanvas;
  43. interface nsIDOMSVGRect;
  44.  
  45. /**
  46.  * \addtogroup renderer_interfaces Rendering Engine Interfaces
  47.  * @{
  48.  */
  49.  
  50. /**
  51.  * One of a number of interfaces (all starting with nsISVGRenderer*)
  52.  * to be implemented by an SVG rendering engine. See nsISVGRenderer
  53.  * for more details.
  54.  *
  55.  * The SVG rendering backend uses this interface to communicate to the
  56.  * rendering engine-native path objects.
  57.  *
  58.  * A path geometry object is instantiated by the rendering backend for
  59.  * a given nsISVGPathGeometrySource object with a call to
  60.  * nsISVGRenderer::createPathGeometry(). The path geometry object is
  61.  * assumed to store a reference to its associated source object and
  62.  * provide rendering, hit-testing and metrics for the path described
  63.  * by the nsISVGPathGeometrySource members.
  64.  */
  65. [scriptable, uuid(1e4a2bc7-96e6-4c4d-80a6-e284cec9e3aa)]
  66. interface nsISVGRendererPathGeometry : nsISupports
  67. {
  68.   /**
  69.    * Paint this object.
  70.    *
  71.    * @param canvas The canvas to render to.
  72.    */
  73.   void render(in nsISVGRendererCanvas canvas);
  74.   
  75.   /**
  76.    * Called by this object's corresponding nsISVGPathGeometrySource as
  77.    * a notification that some of the source's data (identified by
  78.    * paramter 'updatemask') has changed.
  79.    *
  80.    * @param updatemask An OR-ed combination of the UPDATEMASK_*
  81.    * constants defined in nsISVGPathGeometrySource.
  82.    * @return Region that needs to be redrawn.
  83.    */
  84.   nsISVGRendererRegion update(in unsigned long updatemask);
  85.   
  86.   /**
  87.    * Get a region object describing the area covered with paint by
  88.    * this path geometry.
  89.    *
  90.    * @return Covered region.
  91.    */
  92.   nsISVGRendererRegion getCoveredRegion();
  93.  
  94.   /**
  95.    * Hit-testing method. Does this path geometry (with all relevant
  96.    * transformations applied) contain the point x,y? Mode of operation
  97.    * (e.g. whether to test fill or stroke) is determined by
  98.    * nsISVGPathGeometrySource::hittestMask.
  99.    *
  100.    * @param x X-coordinate of test point.  @param y Y-coordinate of
  101.    * test point.
  102.    * @return PR_TRUE if the path geometry contains the point,
  103.    * PR_FALSE otherwise.
  104.    */
  105.   boolean containsPoint(in float x, in float y);
  106.  
  107.   /**
  108.    * Bounding box (does not include stroke width)
  109.    */
  110.   readonly attribute nsIDOMSVGRect boundingBox;
  111.   
  112.   /* XXX segment at length, point at length */
  113. };
  114.  
  115. /** @} */
  116.